Web Service: Workflows

Modified on 2011/10/11 19:20 by Charles Categorized as Web Service
{toc}

===Web Service Web Methods for Workflows===
(return to [WebServiceJetfire|Jetfire Web Service])

This page contains a number of web methods that are used to get workflows.

*   [#GetCollection|Get Collection]
*   [#GetList|Get List]
*   [#GetNamedWorkflows|Get Named Workflows]
*   [#GetNamedWorkflowsForListItems|Get Named Workflows for List Items]
*   [#GetNamedWorkflowsInCurrentState|Get Named Workflows in Current State]
*   [#GetWorkflow|Get Workflow]
*   [#GetWorkflowBySubject|Get Workflow by Subject]
*   [#GetWorkflowStructure|Get Workflow Structure]
*   [#GetWorkflows|Get Workflows]
*   [#GetWorkflowsInWorkspace|Get Workflow in Workspace]
*   [#Workflows|Workflows]
*   [#Workspaces|Workspaces] 

[anchor|#GetWorkflows]
====Get Workflows====

[anchor|#GetNamedWorkflows]
====Get Named Workflows====
This methods gets the workflows requested by the class name.

Prerequisites: Must be logged in.
Send: Parameters for this web method include:
* Nexus Key received during login
* a comma-delimited list of workflow class names

@@
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetNamedWorkflows xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
    </GetNamedWorkflows>
  </soap:Body>
</soap:Envelope>@@

Receive: The return value is an xml string that contains a list of Workflows.  

Success Response:
@@<?xml version='1.0' encoding='utf-8' ?>
<Workflows xmlns="http://schemas.Jetfire.ca/Workflows">
	<Workflow>
		<Properties>
			<Property Name="Guid" Value="8a603aac-1b8b-4f78-b451-146bf4a720a9" Label="Guid" ToolTip="Guid" Display="False" FormElement="Label" ClassName="plainString" Position="0"/>
			<Property Name="Subject" Value="chingers" Label="Subject" ToolTip="Subject" Display="False" FormElement="TextBox" ClassName="string" Position="1"/>
			<Property Name="WorkflowClass" Value="UserLogin" Label="WorkflowClass" ToolTip="WorkflowClass" Display="False" FormElement="Label" ClassName="plainString" Position="2"/>
			<Property Name="CurrentState" Value="" Label="CurrentState" ToolTip="CurrentState" Display="False" FormElement="Label" ClassName="plainString" Position="3"/>
		</Properties>
		<Methods></Methods>
	</Workflow>
<-- snip -->
</Workflows>@@

Failure Response: If Workflows are not found, then the xml string contains an error message.
@@<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Workflow not found"/>
</Errors>@@

[anchor|#GetWorkflow]
====Get Workflow====

This method retrieves the properties and methods for a specific workflow, identified by the Guid.

Prerequisites: Must be logged in.
Send: Parameters for this web method include:
* Nexus Key received during login
* the value of the workflow guid

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWorkflow xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <guid>string</guid>
    </GetWorkflow>
  </soap:Body>
</soap:Envelope>@@

Receive:  The return value is an xml string that contains a Workflows.  The first Workflow is the found Workflow.  If Workflows are not found, then the xml string contains an error message.

Success Response:
@@<?xml version='1.0' encoding='utf-8' ?>
<Workflows xmlns="http://schemas.Jetfire.ca/Workflows">
	<Workflow>
		<Properties>
			<Property Name="Name" Value="chingers" Label="Login ID" ToolTip="The Login ID used to login" Display="True" FormElement="Label" ClassName="plainString" Position="1"/>
			<Property Name="ToolTip" Value="Club Admin for Military Trail Wrestling Club" Label="Comment" ToolTip="The description about the user" Display="True" FormElement="RichTextBox" ClassName="string" Position="3"/>
<-- snip -->
			<Property Name="Subject" Value="chingers" Label="Subject" ToolTip="Subject" Display="False" FormElement="TextBox" ClassName="string" Position="1000"/>
			<Property Name="CurrentState" Value="" Label="CurrentState" ToolTip="CurrentState" Display="False" FormElement="Label" ClassName="plainString" Position="1000"/>
		</Properties>
		<Methods></Methods>
	</Workflow>
</Workflows>@@

Failure Response: If Workflows are not found, then the xml string contains an error message.
@@<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Workflow not found"/>
</Errors>@@

[anchor|#GetWorkflowBySubject]
====Get Workflow By Subject====

This method gets a workflow by its subject.

Prerequisites: Must be logged in.
Send: Parameters for this web method include:
* Nexus Key received during login
* the name of the workflow class
* the value of the subject being queried

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWorkflowBySubject xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
      <subject>string</subject>
    </GetWorkflowBySubject>
  </soap:Body>
</soap:Envelope>@@

Receive: The return value is an xml string that contains a list of Workflows.  If Workflows are not found, then the xml string contains an error message.

Success Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Workflows xmlns="http://schemas.Jetfire.ca/Workflows">
	<Workflow>
		<Properties>
			<Property Name="Name" Value="chingers" Label="Login ID" ToolTip="The Login ID used to login" Display="True" FormElement="Label" ClassName="plainString" Position="1"/>
			<Property Name="ToolTip" Value="Club Admin for Military Trail Wrestling Club" Label="Comment" ToolTip="The description about the user" Display="True" FormElement="RichTextBox" ClassName="string" Position="3"/>
<-- snip -->
			<Property Name="Subject" Value="chingers" Label="Subject" ToolTip="Subject" Display="False" FormElement="TextBox" ClassName="string" Position="1000"/>
			<Property Name="CurrentState" Value="" Label="CurrentState" ToolTip="CurrentState" Display="False" FormElement="Label" ClassName="plainString" Position="1000"/>
		</Properties>
		<Methods></Methods>
	</Workflow>
</Workflows>@@

Failure Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Workflow not found"/>
</Errors>@@

[anchor|#GetWorkflowStructure]
====Get Workflow Structure====

This method gets the properties and methods for a workflow identified by a Guid, as well as any workflows contained in workflow properties.

Prerequisites: Must be logged in.
Send: Parameters for this web method include:
* Nexus Key received during login
* the value of the workflow guid

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWorkflowStructure xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <guid>string</guid>
    </GetWorkflowStructure>
  </soap:Body>
</soap:Envelope>@@

Receive:  The return value is an xml string that contains a list of Workflows.  The list contains all workflows found in the target workflow.  If Workflows are not found, then the xml string contains an error message.

Success Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Workflows xmlns="http://schemas.Jetfire.ca/Workflows">
	<Workflow>
		<Properties>
			<Property Name="Name" Value="chingers" Label="Login ID" ToolTip="The Login ID used to login" Display="True" FormElement="Label" ClassName="plainString" Position="1"/>
			<Property Name="ToolTip" Value="Club Admin for Military Trail Wrestling Club" Label="Comment" ToolTip="The description about the user" Display="True" FormElement="RichTextBox" ClassName="string" Position="3"/>
<-- snip -->
			<Property Name="Subject" Value="chingers" Label="Subject" ToolTip="Subject" Display="False" FormElement="TextBox" ClassName="string" Position="1000"/>
			<Property Name="CurrentState" Value="" Label="CurrentState" ToolTip="CurrentState" Display="False" FormElement="Label" ClassName="plainString" Position="1000"/>
		</Properties>
		<Methods></Methods>
	</Workflow>
</Workflows>@@

Failure Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Workflow not found"/>
</Errors>@@

[anchor|#GetNamedWorkflowsInCurrentState]
====Get Workflows in Current State====

This method gets all workflows where the workflow is in the requested state.

Prerequisites: Must be logged in.
Send: Parameters for this web method include:
* Nexus Key received during login
* the name of the workflow class
* The value of the Workflow Current State that is requested

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetNamedWorkflowsInCurrentState xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
      <currentState>string</currentState>
    </GetNamedWorkflowsInCurrentState>
  </soap:Body>
</soap:Envelope>@@

Receive:  The return value is an xml string that contains a list of Workflows.  If Workflows are not found, then the xml string contains an error message.

Success Response:
@@<?xml version='1.0' encoding='utf-8' ?>
<Workflows xmlns="http://schemas.Jetfire.ca/Workflows">
	<Workflow>
		<Properties>
			<Property Name="Name" Value="chingers" Label="Login ID" ToolTip="The Login ID used to login" Display="True" FormElement="Label" ClassName="plainString" Position="1"/>
			<Property Name="ToolTip" Value="Club Admin for Military Trail Wrestling Club" Label="Comment" ToolTip="The description about the user" Display="True" FormElement="RichTextBox" ClassName="string" Position="3"/>
<-- snip -->
			<Property Name="Subject" Value="chingers" Label="Subject" ToolTip="Subject" Display="False" FormElement="TextBox" ClassName="string" Position="1000"/>
			<Property Name="CurrentState" Value="" Label="CurrentState" ToolTip="CurrentState" Display="False" FormElement="Label" ClassName="plainString" Position="1000"/>
		</Properties>
		<Methods></Methods>
	</Workflow>
</Workflows>@@

Failure Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Workflow not found"/>
</Errors>@@

[anchor|#GetWorkflowsInWorkspace]
====Get Workflows in Workspace====

This methods retrieves all workflows for the requested workspace.

Prerequisites: Must be logged in.
Send: Parameters for this web method include: 
* Nexus Key received during login
* The name of the workflow class
* The name of the Workspace
* A flag whether all versions of workflows are required

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWorkflowsInWorkspace xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
      <wsName>string</wsName>
      <allVersions>boolean</allVersions>
    </GetWorkflowsInWorkspace>
  </soap:Body>
</soap:Envelope>@@

Received:  The return value is an xml string that contains a list of Workflows.  If Workflows are not found, then the xml string contains an error message.

Success Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Workflows xmlns="http://schemas.Jetfire.ca/Workflows">
	<Workflow>
		<Properties>
			<Property Name="Name" Value="chingers" Label="Login ID" ToolTip="The Login ID used to login" Display="True" FormElement="Label" ClassName="plainString" Position="1"/>
			<Property Name="ToolTip" Value="Club Admin for Military Trail Wrestling Club" Label="Comment" ToolTip="The description about the user" Display="True" FormElement="RichTextBox" ClassName="string" Position="3"/>
<-- snip -->
			<Property Name="Subject" Value="chingers" Label="Subject" ToolTip="Subject" Display="False" FormElement="TextBox" ClassName="string" Position="1000"/>
			<Property Name="CurrentState" Value="" Label="CurrentState" ToolTip="CurrentState" Display="False" FormElement="Label" ClassName="plainString" Position="1000"/>
		</Properties>
		<Methods></Methods>
	</Workflow>
</Workflows>@@

Failure Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Workflow not found"/>
</Errors>@@

[anchor|#GetCollection]
====Get Collection====

This method retrieves a collection of workflows based on the name of the collection.

Prerequisites: Must be logged in.
Send: Parameters for this web method include: 
* Nexus Key received during login
* a unique Guid that defines the collection
* the name of the collection

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCollection xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <collectionGuid>string</collectionGuid>
      <collectionName>string</collectionName>
    </GetCollection>
  </soap:Body>
</soap:Envelope>@@

Received: to be done.

[anchor|#GetList]
====Get List====

This method retrieves a list of workflows for a named list.

Prerequisites: Must be logged in.
Send: Parameters for this web method include: 
* Nexus Key received during login
* The name of the requested list, e.g. Province.

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetList xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <listName>string</listName>
    </GetList>
  </soap:Body>
</soap:Envelope>@@

Received: this example shows the response when Province is requested.{BR}
Note: Jetfire enumerators do not have a Guid.

Success Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Workflows xmlns="http://schemas.Jetfire.ca/Workflows">
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="None" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="British_Columbia" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Alberta" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Saskatchewan" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Manitoba" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Ontario" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Quebec" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Prince_Edward_Island" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Nova_Scotia" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="New_Brunswich" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Newfoundland_Labrador" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="North_West_Territories" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Nunavut" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
	<Workflow>
		<Properties>
			<Property Name="Subject" Value="Yukon" Label="Subject" ToolTip="Subject" FormElement="Label" ClassName="enumerator"/>
			<Property Name="WorkflowClass" Value="Province" Label="WorkflowClass" ToolTip="WorkflowClass" FormElement="Label" ClassName="string"/>
		</Properties>
	</Workflow>
</Workflows>@@

Failure Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Workflow not found"/>
</Errors>@@

[anchor|#GetNamedWorkflowsForListItems]
====Get Named Workflows for List Items====

This method retrieves a trimmed list of workflows that can be used to populate a drop down list.  The displayed text is the subject and the value of the option in the list is the Guid.

Prerequisites: Must be logged in.
Send: Parameters for this web method include: 
* Nexus Key received during login
* The name of the workflow class requested
* a comma-delimited list of requested properties.  If left blank, then the Subject, Guid, WorkflowClass and CurrentState is returned.

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetNamedWorkflowsForListItems xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
      <properties>string</properties>
    </GetNamedWorkflowsForListItems>
  </soap:Body>
</soap:Envelope>@@

Received:

Success Response:
@@<?xml version='1.0' encoding='utf-8' ?>
<Workflows xmlns="http://schemas.Jetfire.ca/Workflows">
	<Workflow>
		<Properties>
			<Property Name="Guid" Value="8a603aac-1b8b-4f78-b451-146bf4a720a9" Label="Guid" ToolTip="Guid" Display="False" FormElement="Label" ClassName="plainString" Position="1000"/>
			<Property Name="WorkflowClass" Value="UserLogin" Label="WorkflowClass" ToolTip="WorkflowClass" Display="False" FormElement="Label" ClassName="plainString" Position="1000"/>
			<Property Name="Subject" Value="chingers" Label="Subject" ToolTip="Subject" Display="False" FormElement="TextBox" ClassName="string" Position="1000"/>
			<Property Name="CurrentState" Value="" Label="CurrentState" ToolTip="CurrentState" Display="False" FormElement="Label" ClassName="plainString" Position="1000"/>
		</Properties>
		<Methods></Methods>
	</Workflow>
<-- snip -->
</Workflows>@@

Failure Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Workflow not found"/>
</Errors>@@

[anchor|#Workflows]
====Workflows====

This method retrieves all workflows from the Nexus.  Warning: this method may time out, if there are too many workflows.

Prerequisites: Must be logged in.
Send: Parameters for this web method include: 
* Nexus Key received during login

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Workflows xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
    </Workflows>
  </soap:Body>
</soap:Envelope>@@

Received:  The xml string is a a list of workflows, similar to the other received examples on this page.

[anchor|#Workspaces]
====Workspaces====

This method retrieves all workspaces from the Nexus.

Prerequisites: Must be logged in.
Send: Parameters for this web method include: 
* Nexus Key received during login

@@<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Workspaces xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
    </Workspaces>
  </soap:Body>
</soap:Envelope>@@

Received:

Success Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Workflows xmlns="http://schemas.Jetfire.ca/Workflows">
	<Workflow>
		<Properties>
			<Property Name="Guid" Value="cd53e6d1-00ee-421d-8f05-cae4be36b851" Label="Guid" ToolTip="Guid" Display="False" FormElement="Label" ClassName="plainString" Position="0"/>
			<Property Name="Subject" Value="Public" Label="Subject" ToolTip="Subject" Display="False" FormElement="TextBox" ClassName="string" Position="1"/>
			<Property Name="WorkflowClass" Value="workspace" Label="WorkflowClass" ToolTip="WorkflowClass" Display="False" FormElement="Label" ClassName="plainString" Position="2"/>
			<Property Name="CurrentState" Value="" Label="CurrentState" ToolTip="CurrentState" Display="False" FormElement="Label" ClassName="plainString" Position="3"/>
		</Properties>
		<Methods></Methods>
	</Workflow>
</Workflows>@@

Failure Response: 
@@<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Workflow not found"/>
</Errors>@@
Meta Keywords:
Meta Description:
Change Comment: